Skip to content

docs: add Zensical documentation site #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
psteinroe merged 4 commits into from
Jan 16, 2026
Merged

docs: add Zensical documentation site #39

psteinroe merged 4 commits into from
Jan 16, 2026

Conversation

@psteinroe
Copy link
Owner

@psteinroe psteinroe commented Jan 13, 2026 •
edited
Loading

Summary

  • Add comprehensive documentation using Zensical framework
  • Auto-deploy to GitHub Pages on push to main
  • Simplified README pointing to docs site

Documentation Structure

docs/
├── index.md                    # Introduction
├── getting-started/            # Requirements, configuration, running
├── concepts/                   # Architecture, subscriptions, extensions, failover
├── sinks/                      # All 12 sink configurations
├── guides/                     # Custom sinks, manual events, partitions
└── reference/                  # Config, subscriptions table, event format

New Commands

  • just docs - Serve documentation locally
  • just docs-build - Build documentation

Test plan

  • Run just docs and verify site renders correctly
  • Check all navigation links work
  • Verify sink documentation pages have correct configuration examples

@psteinroe
docs: add Zensical documentation site
e2c7fbc 
Add comprehensive documentation using Zensical framework:

- Getting started guide (requirements, configuration, running)
- Concepts (how-it-works, subscriptions, payload-extensions, event-metadata, failover)
- All 12 sink configurations (Kafka, NATS, RabbitMQ, Redis, Webhook, AWS, GCP, search)
- Guides (custom sinks, manual events, partition management)
- Reference (configuration, subscriptions table, event format)

Also includes:
- GitHub Actions workflow for auto-deploy to GitHub Pages
- Simplified README pointing to docs site
- justfile commands: `just docs` and `just docs-build`
@psteinroe
docs: add logo to docs and README
8e15103
@psteinroe
improve
0749dbf
@psteinroe
progress
fb1f620
@psteinroe psteinroe merged commit ac94181 into main Jan 16, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@psteinroe